Skip to main content

PDF Template

PdfTemplate

Generates PDF from AsciiDoc files from Apache Freemarker templates.

Description​

A Reporter that creates PDF files using a combination of Apache Freemarker templates and AsciiDoc with AsciidoctorJ as Java interface and AsciidoctorJ PDF as PDF file generator. For each Freemarker template provided using the options described below, a separate intermediate file is created that can be processed by AsciidoctorJ. If no options are provided, the "disclosure_document" template is used, and if security vulnerability information is available also the "vulnerability_report" template.

After the intermediate files are generated, they are processed by AsciidoctorJ PDF. A PDF theme can be handed over to AsciidoctorJ PDF in which properties like fonts or images displayed in the PDF can be adjusted; see the Theme Guide. The path to this theme can be set in the options as described below. Note that only one theme can be set that is used for all given templates. If no theme is given, a default built-in theme of AsciidoctorJ PDF is used.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      PdfTemplate:
        options:
          templateIds: <OPTIONAL_STRING_LIST>
          templatePaths: <OPTIONAL_STRING_LIST>
          pdfThemeFile: "uri:classloader:/pdf-theme/pdf-theme.yml"
          pdfFontsDir: "uri:classloader:/fonts"

Options​

templateIds​

STRING_LIST

Alias: template.id

A comma-separated list of IDs of templates provided by ORT. If no template id or path is provided, the "disclosure_document" template is used, and if the ORT result contains an advisor run, the "vulnerability_report" template is used as well.

templatePaths​

STRING_LIST

Alias: template.path

A comma-separated list of paths to template files provided by the user.

pdfThemeFile​

STRING Default

Alias: pdf.theme.file

The path to an AsciiDoc PDF theme file.

pdfFontsDir​

STRING Default

Alias: pdf.fonts.dir

The path to a directory containing custom fonts.